Skip to content

Common Custom Code Examples #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Nov 22, 2024
Merged

Common Custom Code Examples #200

merged 16 commits into from
Nov 22, 2024

Conversation

PoojaB26
Copy link
Collaborator

Description

Provide a brief overview of what this documentation update is about. Explain what sections or topics are being added or revised.

Linear ticket and magic word Fixes DEVR-599

Type of change

  • Typo fix
  • New feature
  • Enhancement to current docs
  • Removed outdated references
  • Update assets

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions github-actions bot requested a review from pinkeshmars November 12, 2024 09:07
Copy link
Collaborator

@leighajarett leighajarett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Came across this PR and this looks really good, thanks for working on it! Left a few comments


### Accessing FlutterFlow Generated Classes

Most custom FlutterFlow classes are prefixed with `FF<ClassName>` or `FlutterFlow<ClassName>`. If you need to access these classes in your custom code, simply type "FF" or "FlutterFlow" in the code editor to locate them easily.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would recommend specifying what classes means here. In this case it sounds like widgets we use under the hood, as opposed to components which are also FlutterFlow Generated Classes.

Suggest putting a one liner like "In the generated code, FlutterFlow uses a combination of widgets from the Flutter framework, popular pub.dev packages and custom widgets created by the FlutterFlow team. You may want to reference widgets created by the FlutterFlow team in your own generated code, such as FFDropdown or ..... these widgets are usually prefixed...."

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually this is not limited to widgets or components only. It could be other classes like FFUploadedFile or FFPlace or FFRoute, basically any FlutterFlow class exposed to users.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thats why it is helpful to explain what a class means in this context :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense! Done!

Copy link
Collaborator

@pinkeshmars pinkeshmars left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, nice work @PoojaB26! small nits from my side.

@PoojaB26
Copy link
Collaborator Author

All review comments have been addressed @leighajarett @pinkeshmars

@leighajarett
Copy link
Collaborator

@PoojaB26 it seems like two of the comments I added still have not been resolved

@leighajarett leighajarett self-requested a review November 20, 2024 20:21
@PoojaB26
Copy link
Collaborator Author

@leighajarett I guess just the classes part needs to be added? Rest seems to be addressed?

@PoojaB26
Copy link
Collaborator Author

Added the class info @leighajarett

@PoojaB26 PoojaB26 merged commit 8dce9fc into main Nov 22, 2024
1 check passed
@PoojaB26 PoojaB26 deleted the pooja/custom-code-new-examples branch November 22, 2024 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants